************

INTRODUCTION

************


This file describes how to set up and use the Ruby wrapper code with Melissa DATA's Address Object.



*************

PREREQUISITES

*************


To make use of the Address Object Ruby wrapper you will need:


* An installation of a Ruby. This Wrapper tested with Ruby 1.8.1


* The Melissa DATA Address Object library and data files installed.

	Library = libmdAddr.so

	Data Files = mdAddr.dat, mdAddr.nat, mdAddr.str, mdAddr.lic


  These files are installed automatically if you run setup.sh. 


You will need to know the location of these items in order to install and run the Ruby wrapper.


**********************
Wrapper compatibility
**********************

If the provided pre-compiled wrappers are not compatible with your environment, the necessary files for compilation can be found in the 'interfaces' folder of the object's main directory.


*************

Installation

*************


Copy the entire folder that contains this readme.txt into a local directory on your computer.



*****

Setup

*****


Open BuildWrapper.sh in a text editor. Put in the paths to the Address Object library

(libmdAddr.so) and make sure the directory set for the RubyIncludePath is correct.


	mdAddrPath='Path To Your Address Object Library'

	RubyIncludePath='Path To The Ruby Include Directory'


*******************

Running the Script

*******************


Execute BuildWrapper.sh (sh BuildWrapper.sh). This should create a file named mdAddrRubyWrapper.so.


After the files are successfully generated, they are ready for use. Place them in the folder containing your application/project.


************

Dependencies

************


You will need to allow mdAddrRubyWrapper.so to find libmdAddr.so. You can do this by:


	1. Set LD_LIBRARY_PATH to the directory containing libmdAddr.so. 

		ex: export LD_LIBRARY_PATH=/DQT/Current


	or


	2. Copy libmdAddr.so into the directory with _mdAddrRubyWrapper.so.




**************************

Setting up the Sample Code

**************************


Open AddressSample.py for editing. You must set the a license string that you receive from your Melissa Data sales representative and the path to the addr data files:

License = "License Here"

DataPath = "/DQT/Current"



***********************

Running the Sample Code

***********************


Navigate to the directory containing the ruby wrapper using command line and type:

	ruby AddressSample.rb


*******

Updates

*******


The wrapper does not need to be rebuilt for updates. Simply replace the Address Object (libmdAddr.so) and data files. However, if there is a new method added, you will need to rebuild the wrapper to use that new method.


****

Note

****


Here are some general solutions if you run into problems:


Q. I get an error saying "libmdAddr.so: shared object cannot be opened ."

A. This means that mdAddrRubyWrapper.so cannot link to libmdAddr.so. Please following one of the steps in the Setup section above.




COPYRIGHT NOTICE


(C) 2014 Melissa Data Corporation. All rights reserved.

